﻿//////////////////////////////////////////////////////////////////////////////
//
// Copyright © 1998-2024 Glodon Company Limited.
//
// Licensed under the MIT License
//
// Permission is hereby granted, free of charge, to any person obtaining a
// copy of this software and associated documentation files (the “Software”),
// to deal in the Software without restriction, including without limitation
// the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
// sell copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
// THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
//
//////////////////////////////////////////////////////////////////////////////
#pragma once

#include "GcmpGUiBaseImpl.h"
#include "IControlDefinition.h"
#include "GbmpDefines.h"

namespace gcmp
{
    class IControlState;

    /// \brief 公共控件定义类
    ///
    /// 用于定义控件基本属性和状态
    class GCMP_GUI_BASE_IMPL_EXPORT ControlDefinition
    {
        CANNOT_COPY_OR_ASSIGN(ControlDefinition);
    public:
        ControlDefinition(const std::wstring& id, const std::wstring& caption, const std::wstring& tooltip);
        virtual ~ControlDefinition();

    public:
        std::wstring GetId() const { return m_id; }
        std::wstring GetCaption() const { return m_caption; }
        std::wstring GetTooltip() const { return m_tooltip; }
        bool IsVisible() const;
        virtual bool IsEnabled() const;
        bool SetEnabled(bool enabled);
        bool SetVisible(bool visible);
        bool SetCaption(const std::wstring& caption) { m_caption = caption; return true; }
        bool SetTooltip(const std::wstring& tooltip) { m_tooltip = tooltip; return true; }
        ControlDefinitionType GetType() const { return ControlDefinitionType::UnKnow; }

    protected:
        std::wstring m_id;        // 用来标识控件的字符串名称
        std::wstring m_caption;     // 控件标题。
        std::wstring m_tooltip;
        bool m_visible;
        bool m_enabled;
        OwnerPtr<IControlState> m_pControlState;
    };  
}
